Skip to main content

Installation

Get up and running with Refract in minutes. This guide covers all installation methods, from quick starts to advanced configurations.

Prerequisites​

Before installing Refract, ensure you have the following:

System Requirements​

  • Node.js: Version 16.0.0 or higher
  • npm: Version 7.0.0 or higher (comes with Node.js)
  • Operating System: Windows, macOS, or Linux
  • Browser: Chrome 90+, Firefox 88+, Safari 14+, or Edge 90+

Check Your Environment​

# Check Node.js version
node --version
# Should output v16.0.0 or higher

# Check npm version
npm --version
# Should output 7.0.0 or higher

# Or check yarn version (optional)
yarn --version
# Should output 1.22.0 or higher

# Or check pnpm version (optional)
pnpm --version
# Should output 6.0.0 or higher

Installing Node.js​

If you don't have Node.js installed:

Option 1: Official Installer

  • Download from nodejs.org
  • Choose LTS version for stability
  • Run installer and follow prompts

Option 2: Using NVM (Node Version Manager)

# macOS/Linux
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
nvm install node
nvm use node

# Windows (using nvm-windows)
# Download from: https://github.com/coreybutler/nvm-windows
nvm install latest
nvm use latest
  1. [Quick Start Tutorial] - Build your first app
  2. [Core Concepts] - Understand the fundamentals
  3. [Examples] - Learn from sample projects
  4. [API Reference] - Explore the full API
  5. [DevTools Guide] - Master debugging

Congratulations! You've successfully installed Refract. Start building amazing reactive applications!